/* 
 * Copyright (c) 2012, Fromentin Xavier, Schnell Michaël, Dervin Cyrielle, Brabant Quentin
 * All rights reserved.
 * 
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 *      * Redistributions of source code must retain the above copyright
 *       notice, this list of conditions and the following disclaimer.
 *      * Redistributions in binary form must reproduce the above copyright
 *       notice, this list of conditions and the following disclaimer in the
 *       documentation and/or other materials provided with the distribution.
 *      * The names of its contributors may not be used to endorse or promote products
 *       derived from this software without specific prior written permission.
 * 
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
 * DISCLAIMED. IN NO EVENT SHALL Fromentin Xavier, Schnell Michaël, Dervin Cyrielle OR Brabant Quentin 
 * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */
package kameleon.document;

import kameleon.exception.InvalidPropertyException;

/**
 * Represents a foot note.
 * 
 * <p>Contains all of the informations concerning a given foot note. 
 * The content can only be raw text (with various properties)
 * 
 * <p>Standard properties include : alignment and format (bold, italic, ...).
 * 
 * @author		Fromentin Xavier, Schnell Michaël, Dervin Cyrielle, Brabant Quentin
 * @version		1.0
 */
public class FootNote extends TextParagraphElement {

	/**
	 * Needed to serialize this class.
	 * 
	 * @see		java.io.Serializable
	 */
	private static final long serialVersionUID = 8974435562590068275L;
	
	/**
	 * Default text used when creating an instance of {@code Text}.
	 */
	private static final String DEFAULT_TEXT_BODY = "" ;//$NON-NLS-1$
	
	/**
	 * Default text used when creating an instance of {@code Text}.
	 */
	private static final Integer DEFAULT_TEXT_ALIGNMENT = LEFT_ALIGNMENT ;
	
	/**
	 * Builds an instance with default properties.
	 * 
	 * <p>The default properties are the following :
     * <ul>
     * <li>text body: {@code ""} (empty)
     * <li>text alignment: left
     * </ul>
	 */
	public FootNote() {
		super() ;
		// Setting the default properties
		try {
			this.setProperty(TEXT_BODY, DEFAULT_TEXT_BODY) ;
			this.setProperty(TEXT_ALIGNMENT, DEFAULT_TEXT_ALIGNMENT) ;
		} catch (InvalidPropertyException e) {/* Never called. */}
	}// Text()

	/**
	 * Builds an instance with the given text and a default text alignment (left).
	 * 
	 * @param 	text
	 * 			text for this {@code FootNote}
	 */
	public FootNote(String text) {
		this() ;
		try {
			this.setProperty(TEXT_BODY, text) ;
		} catch (InvalidPropertyException e) {/* Never called. */}
	}// FootNote()

}// class FootNote